<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

	<title>Module: CurrencySpy</title>

	<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />

	<script src="./js/jquery.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="./js/thickbox-compressed.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="./js/quicksearch.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="./js/darkfish.js" type="text/javascript"
		charset="utf-8"></script>

</head>
<body class="module">

	<div id="metadata">
		<div id="home-metadata">
			<div id="home-section" class="section">
        <h3 class="section-header">
          <a href="./index.html">Home</a>
          <a href="./index.html#classes">Classes</a>
          <a href="./index.html#methods">Methods</a>
        </h3>
			</div>
		</div>

		<div id="file-metadata">
			<div id="file-list-section" class="section">
				<h3 class="section-header">In Files</h3>
				<div class="section-body">
					<ul>
					
						<li><a href="./lib/currency_spy_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy.rb">lib/currency_spy.rb</a></li>
					
						<li><a href="./lib/currency_spy/version_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy/version.rb">lib/currency_spy/version.rb</a></li>
					
						<li><a href="./lib/currency_spy/nbp_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy/nbp.rb">lib/currency_spy/nbp.rb</a></li>
					
						<li><a href="./lib/currency_spy/dnb_nord_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy/dnb_nord.rb">lib/currency_spy/dnb_nord.rb</a></li>
					
						<li><a href="./lib/currency_spy/scraper_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy/scraper.rb">lib/currency_spy/scraper.rb</a></li>
					
						<li><a href="./lib/currency_spy/walutomat_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/currency_spy/walutomat.rb">lib/currency_spy/walutomat.rb</a></li>
					
					</ul>
				</div>
			</div>

			
		</div>

		<div id="class-metadata">

			<!-- Parent Class -->
			

			<!-- Namespace Contents -->
			
			<div id="namespace-list-section" class="section">
				<h3 class="section-header">Namespace</h3>
				<ul class="link-list">
					
					<li><span class="type">CLASS</span> <a href="CurrencySpy/DnbNord.html">CurrencySpy::DnbNord</a></li>
					
					<li><span class="type">CLASS</span> <a href="CurrencySpy/Nbp.html">CurrencySpy::Nbp</a></li>
					
					<li><span class="type">CLASS</span> <a href="CurrencySpy/Scraper.html">CurrencySpy::Scraper</a></li>
					
					<li><span class="type">CLASS</span> <a href="CurrencySpy/Walutomat.html">CurrencySpy::Walutomat</a></li>
					
				</ul>
			</div>
			

			<!-- Method Quickref -->
			
			<div id="method-list-section" class="section">
				<h3 class="section-header">Methods</h3>
				<ul class="link-list">
					
					<li><a href="#method-c-datestr">::datestr</a></li>
					
				</ul>
			</div>
			

			<!-- Included Modules -->
			
		</div>

		<div id="project-metadata">
			
			
			<div id="fileindex-section" class="section project-section">
				<h3 class="section-header">Files</h3>
				<ul>
				
					<li class="file"><a href="./Gemfile.html">Gemfile</a></li>
				
					<li class="file"><a href="./LICENSE.html">LICENSE</a></li>
				
					<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
				
					<li class="file"><a href="./Rakefile.html">Rakefile</a></li>
				
					<li class="file"><a href="./nbproject/private/rake-d_txt.html">rake-d.txt</a></li>
				
				</ul>
			</div>
			

			<div id="classindex-section" class="section project-section">
				<h3 class="section-header">Class Index
					<span class="search-toggle"><img src="./images/find.png"
						height="16" width="16" alt="[+]"
						title="show/hide quicksearch" /></span></h3>
				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
				<fieldset>
					<legend>Quicksearch</legend>
					<input type="text" name="quicksearch" value=""
						class="quicksearch-field" />
				</fieldset>
				</form>

				<ul class="link-list">
				
					<li><a href="./CurrencySpy.html">CurrencySpy</a></li>
				
					<li><a href="./CurrencySpy/DnbNord.html">CurrencySpy::DnbNord</a></li>
				
					<li><a href="./CurrencySpy/Nbp.html">CurrencySpy::Nbp</a></li>
				
					<li><a href="./CurrencySpy/Scraper.html">CurrencySpy::Scraper</a></li>
				
					<li><a href="./CurrencySpy/Walutomat.html">CurrencySpy::Walutomat</a></li>
				
				</ul>
				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
			</div>

			
		</div>
	</div>

	<div id="documentation">
		<h1 class="module">CurrencySpy</h1>

		<div id="description">
			<p>
This gem is a set of scrapers to fetch currencies from various
institutions&#8217; websites. It&#8217;s primary use is to monitor the
changes of currency rates across different institutions to calculate
spreads (difference between the buying rate and the selling rate. It
fetches the rates in PLN (Polish Zloty) however if there&#8217;s a demand I
could extend the gem to be more flexible.
</p>
<table>
<tr><td valign="top">Author</td><td><p>
Łukasz Badura  (<a href="mailto:lukasz@niebo.net">lukasz@niebo.net</a>)
</p>
</td></tr>
<tr><td valign="top">Copyright</td><td><p>
Copyright &#169; 2011 Łukasz Badura
</p>
</td></tr>
<tr><td valign="top">License</td><td><p>
MIT license.
</p>
</td></tr>
</table>

		</div>

		<!-- Constants -->
		
		<div id="constants-list" class="section">
			<h3 class="section-header">Constants</h3>
			<dl>
			
				<dt><a name="DATE_FORMAT">DATE_FORMAT</a></dt>
				
				<dd class="description"><p>
Default date format used for date presentation across the code
</p></dd>
				
			
				<dt><a name="VERSION">VERSION</a></dt>
				
				<dd class="description"><p>
Stores the version of the currency_spy gem
</p></dd>
				
			
			</dl>
		</div>
		

		<!-- Attributes -->
		

		<!-- Methods -->
		
		<div id="public-class-method-details" class="method-section section">
			<h3 class="section-header">Public Class Methods</h3>

		
			<div id="datestr-method" class="method-detail ">
				<a name="method-c-datestr"></a>

				<div class="method-heading">
				
					<span class="method-name">datestr</span><span
						class="method-args">(date)</span>
					<span class="method-click-advice">click to toggle source</span>
				
				</div>

				<div class="method-description">
					
					<p>
Returns a string representation of a given date in the default format
</p>
					

					
					<div class="method-source-code"
						id="datestr-source">
<pre>
    <span class="ruby-comment cmt"># File lib/currency_spy.rb, line 25</span>
25:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">datestr</span>(<span class="ruby-identifier">date</span>)
26:     <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-constant">CurrencySpy</span><span class="ruby-operator">::</span><span class="ruby-constant">DATE_FORMAT</span>)
27:   <span class="ruby-keyword kw">end</span></pre>
					</div>
					
				</div>

				

				
			</div>

		
		</div>
	

	</div>


	<div id="rdoc-debugging-section-dump" class="debugging-section">
	
		<p>Disabled; run with --debug to generate this.</p>
	
	</div>

	<div id="validator-badges">
		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
			Rdoc Generator</a> 1.1.6</small>.</p>
	</div>

</body>
</html>

